Key Performance Indicator (KPI) Widgets

What is a KPI widget?

A KPI widget displays the basic number of a measure or expression. It can include a title and an icon indicator.

KPI Examples

Open the KPI Builder

Select a measure, date type, and aggregate

Formatting a KPI

Change or turn off the KPI title

Add an indicator icon to a KPI

Add a tooltip description

Adjust font size ratios

Make font sizes consistent

KPI Examples

Open the KPI Builder

Click 'Edit'.

Click Insert and then KPI.

The KPI Builder opens. As you enter the KPI measures and set its purpose, the KPI Builder shows a preview of the KPI.

Select a measure, date type, and aggregate

In the KPI Builder, click the Measure tab.

If the measure has a name, you can find it by entering the name in search. If you don't know the name, click Measures to find it on the list.

The last measure you selected displays by default. To change the measure, click the arrows on the default line.

Select the measure from the list.

Formatting a KPI

  1. In the KPI Builder, click the Measures tab.
  2. Click Formatting. You can format:
    • Units: None (no commas), thousands (K), millions (M), billions (B), or percent (%).
    • Suffix: By default there is no suffix label after the measure number. You can add the % label.
    • Decimal: Zero to three decimal places, or all. The default Auto is used by the base data.
    • Currency: Select one from the list (no default label).
  3. Click Back when you are done.
  4. To apply the styles to the measure, click StyleSettings.

  5. Select a font face from the list.
  6. Select a font color (or enter a hex color) and click 'choose'.
  7. When you are done, click Back.
  8. If you want to show the measure title, but not the data, toggle the data off.

  9. Click Save.
  10. Click Publish.

Change or turn off the KPI title

  1. In the Edit mode, click the KPI.
  2. Click the edit button and then click the Edit KPI icon.
  3. In the KPI Builder, click the Title tab.
  4. Highlight the name and then press Back on your keyboard.
  5. Type the new KPI name.
  6. Click Save.
  7. Click Publish.

Turn the title off

  1. In the Edit mode, click the KPI.
  2. Click the edit button and then click the Edit KPI icon.
  3. In the KPI Builder, click the Title tab.
  4. Slide the toggle to off.

  5. Click Save.
  6. Click Publish.

Add an indicator icon to a KPI

  1. In the Edit mode, click the KPI.
  2. Click the edit button and then click the Edit KPI icon.
  3. On the KPI Builder, click the Indicator tab.
  4. By default, the toggle is set to off. Slide the toggle to the right to turn it on.
  5. Select the measure or expression for the indicator.

    Tip: The indicator can use a different measure than the KPI measure.

  6. Click Conditional Formatting.
  7. Use the internal buttons, value slider, and shape/color menus to specify the indicator ranges.

  8. Click Save. You can resize and move the widget just like a dashlet.

    Tip: In some cases you may need to Publish the dashboard to refresh the data and indicator.

Add a tooltip description

  1. In the Edit mode, click the KPI.
  2. Click the edit button and then click Edit Dashlet Properties.

  3. In the description box, enter the text you want the user to see. For more control over formatting, use carriage returns and extra spaces in the text.

    Tip: You can use variables, with either the GetVariable('variable_name') or V{variable_name} syntax, in the description text.

  4. Click Apply.
  5. Click Publish. Hover over the KPI to see the tooltip.

Adjust font size ratios

The scaling ration of settings control the size of the title text versus the measure value number. The slider changes the sizes by proportion.

Make font sizes consistent

The fonts inside KPIs are responsive, meaning that the font size increases or decreases according to the size of the browser window or tablet screen. When you have multiple KPIs, this can result in inconstant font sizing. If you prefer to keep font sizes consistent even as the dashboard or dashlet dimensions change, use the 'Make Font Sizes Consistent' option.

  1. In edit mode, select the KPI. On the toolbar, click the 'Make Font Sizes Consistent' option.
  2. Move the toggle to on.

  3. Repeat step 2 for all additional KPIs.
  4. Optionally, you may want to resize the dashlets to account for the resized fonts.
  5. Click Publish.